HipOpenALClip

OpenAL Buffer works in the following way: If the buffer is streamed, it won't be owned by any source, so it will have total control over itself. That way, it can be reused by any source.

Else, the buffer will be owned by the source for decoding, updating, and pulling data.

version(OpenAL)

class HipOpenALClip : HipAudioClip {

this(IHipAudioDecoder decoder, HipAudioClipHint hint);

this(IHipAudioDecoder decoder, HipAudioClipHint hint, uint chunkSize);

void onUpdateStream(ubyte[] data, uint decodedSize);

HipAudioBufferWrapper createBuffer(ubyte[] data);

void destroyBuffer(HipAudioBuffer* buffer);

void setBufferData(HipAudioBuffer* buffer, ubyte[] data, uint size);

bool hasBuffer;

}

Constructors

this this(IHipAudioDecoder decoder, HipAudioClipHint hint): Undocumented in source.
this this(IHipAudioDecoder decoder, HipAudioClipHint hint, uint chunkSize): Undocumented in source.

Members

Functions

createBuffer HipAudioBufferWrapper createBuffer(ubyte[] data): Allocates ALuint in the bufferwrapper
destroyBuffer void destroyBuffer(HipAudioBuffer* buffer): Undocumented in source. Be warned that the author may not have intended to support it.
onUpdateStream void onUpdateStream(ubyte[] data, uint decodedSize): Undocumented in source. Be warned that the author may not have intended to support it.
setBufferData void setBufferData(HipAudioBuffer* buffer, ubyte[] data, uint size): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

hasBuffer bool hasBuffer;: Undocumented in source.

Inherited Members

From HipAudioClip

decoder IHipAudioDecoder decoder;: Undocumented in source.
dataToDecode ubyte[] dataToDecode;: Unused for non streamed. It is the binary loaded from a file which will be decoded
outBuffer ubyte[] outBuffer;: Unused for non streamed. Where the user will get its audio decoded.
chunkSize uint chunkSize;: Unused for non streamed
hint HipAudioClipHint hint;: Undocumented in source.
totalDecoded size_t totalDecoded;: Undocumented in source.
type HipAudioType type;: Undocumented in source.
encoding HipAudioEncoding encoding;: Undocumented in source.
isStreamed bool isStreamed;: Undocumented in source.
fileName string fileName;: Undocumented in source.
onUpdateStream void onUpdateStream(ubyte[] data, uint decodedSize): Event method called when the stream is updated
createBuffer HipAudioBufferWrapper createBuffer(ubyte[] data): Always alocates a pointer to the buffer data. So, after getting its content. Send it to the recyclable buffers
destroyBuffer void destroyBuffer(HipAudioBuffer* buffer): Undocumented in source.
setBufferData void setBufferData(HipAudioBuffer* buffer, ubyte[] data, uint size): The buffer is actually any kind of external API buffer, it is the buffer contained in HipAudioBufferWrapper.
getHint immutable(HipAudioClipHint)* getHint(): Undocumented in source. Be warned that the author may not have intended to support it.
loadFromMemory bool loadFromMemory(ubyte[] data, HipAudioEncoding encoding, HipAudioType type, void delegate(in ubyte[]) onSuccess, void delegate() onFailure): Should implement the specific loading here
updateStream uint updateStream(): Decodes a bit more of the current buffer
findBuffer HipAudioBufferWrapper* findBuffer(HipAudioBuffer buf): Undocumented in source. Be warned that the author may not have intended to support it.
pollFreeBuffer HipAudioBuffer pollFreeBuffer(): Attempts to get a buffer from the buffer recycler. Used for when loadStreamed must set a buffer available
getBuffer HipAudioBuffer getBuffer(ubyte[] data, uint size): Undocumented in source. Be warned that the author may not have intended to support it.
_getBufferAPI HipAudioBufferAPI* _getBufferAPI(ubyte[] data, uint size): Undocumented in source. Be warned that the author may not have intended to support it.
getAudioClipBackend IHipAudioClip getAudioClipBackend(): Undocumented in source. Be warned that the author may not have intended to support it.
setBufferAvailable void setBufferAvailable(HipAudioBuffer buffer): Undocumented in source. Be warned that the author may not have intended to support it.
loadStreamed uint loadStreamed(ubyte[] data, HipAudioEncoding encoding): Saves which data should be decoded and do 1 decoding frame
getClipData ubyte[] getClipData(): Returns the streambuffer if streamed, else, returns entire sound
getClipSize size_t getClipSize(): Returns how much has been decoded
getDuration float getDuration(): Undocumented in source. Be warned that the author may not have intended to support it.
getSampleRate uint getSampleRate(): Undocumented in source. Be warned that the author may not have intended to support it.
getDecodedDuration float getDecodedDuration(): Undocumented in source. Be warned that the author may not have intended to support it.
onFinishLoading void onFinishLoading(): Undocumented in source. Be warned that the author may not have intended to support it.
isReady bool isReady(): Undocumented in source. Be warned that the author may not have intended to support it.
onDispose void onDispose(): Undocumented in source. Be warned that the author may not have intended to support it.